<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>EventData xref</title>
<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../apidocs/org/slf4j/ext/EventData.html">View Javadoc</a></div><pre>

<a class="jxr_linenumber" name="1" href="#1">1</a>   <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="2" href="#2">2</a>   <em class="jxr_javadoccomment"> * Copyright (c) 2004-2011 QOS.ch</em>
<a class="jxr_linenumber" name="3" href="#3">3</a>   <em class="jxr_javadoccomment"> * All rights reserved.</em>
<a class="jxr_linenumber" name="4" href="#4">4</a>   <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="5" href="#5">5</a>   <em class="jxr_javadoccomment"> * Permission is hereby granted, free  of charge, to any person obtaining</em>
<a class="jxr_linenumber" name="6" href="#6">6</a>   <em class="jxr_javadoccomment"> * a  copy  of this  software  and  associated  documentation files  (the</em>
<a class="jxr_linenumber" name="7" href="#7">7</a>   <em class="jxr_javadoccomment"> * "Software"), to  deal in  the Software without  restriction, including</em>
<a class="jxr_linenumber" name="8" href="#8">8</a>   <em class="jxr_javadoccomment"> * without limitation  the rights to  use, copy, modify,  merge, publish,</em>
<a class="jxr_linenumber" name="9" href="#9">9</a>   <em class="jxr_javadoccomment"> * distribute,  sublicense, and/or sell  copies of  the Software,  and to</em>
<a class="jxr_linenumber" name="10" href="#10">10</a>  <em class="jxr_javadoccomment"> * permit persons to whom the Software  is furnished to do so, subject to</em>
<a class="jxr_linenumber" name="11" href="#11">11</a>  <em class="jxr_javadoccomment"> * the following conditions:</em>
<a class="jxr_linenumber" name="12" href="#12">12</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="13" href="#13">13</a>  <em class="jxr_javadoccomment"> * The  above  copyright  notice  and  this permission  notice  shall  be</em>
<a class="jxr_linenumber" name="14" href="#14">14</a>  <em class="jxr_javadoccomment"> * included in all copies or substantial portions of the Software.</em>
<a class="jxr_linenumber" name="15" href="#15">15</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="16" href="#16">16</a>  <em class="jxr_javadoccomment"> * THE  SOFTWARE IS  PROVIDED  "AS  IS", WITHOUT  WARRANTY  OF ANY  KIND,</em>
<a class="jxr_linenumber" name="17" href="#17">17</a>  <em class="jxr_javadoccomment"> * EXPRESS OR  IMPLIED, INCLUDING  BUT NOT LIMITED  TO THE  WARRANTIES OF</em>
<a class="jxr_linenumber" name="18" href="#18">18</a>  <em class="jxr_javadoccomment"> * MERCHANTABILITY,    FITNESS    FOR    A   PARTICULAR    PURPOSE    AND</em>
<a class="jxr_linenumber" name="19" href="#19">19</a>  <em class="jxr_javadoccomment"> * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE</em>
<a class="jxr_linenumber" name="20" href="#20">20</a>  <em class="jxr_javadoccomment"> * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION</em>
<a class="jxr_linenumber" name="21" href="#21">21</a>  <em class="jxr_javadoccomment"> * OF CONTRACT, TORT OR OTHERWISE,  ARISING FROM, OUT OF OR IN CONNECTION</em>
<a class="jxr_linenumber" name="22" href="#22">22</a>  <em class="jxr_javadoccomment"> * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</em>
<a class="jxr_linenumber" name="23" href="#23">23</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="24" href="#24">24</a>  <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="25" href="#25">25</a>  <strong class="jxr_keyword">package</strong> org.slf4j.ext;
<a class="jxr_linenumber" name="26" href="#26">26</a>  
<a class="jxr_linenumber" name="27" href="#27">27</a>  <strong class="jxr_keyword">import</strong> java.io.Serializable;
<a class="jxr_linenumber" name="28" href="#28">28</a>  <strong class="jxr_keyword">import</strong> java.io.ByteArrayInputStream;
<a class="jxr_linenumber" name="29" href="#29">29</a>  <strong class="jxr_keyword">import</strong> java.io.ByteArrayOutputStream;
<a class="jxr_linenumber" name="30" href="#30">30</a>  <strong class="jxr_keyword">import</strong> java.util.Date;
<a class="jxr_linenumber" name="31" href="#31">31</a>  <strong class="jxr_keyword">import</strong> java.util.HashMap;
<a class="jxr_linenumber" name="32" href="#32">32</a>  <strong class="jxr_keyword">import</strong> java.util.Iterator;
<a class="jxr_linenumber" name="33" href="#33">33</a>  <strong class="jxr_keyword">import</strong> java.util.Map;
<a class="jxr_linenumber" name="34" href="#34">34</a>  <strong class="jxr_keyword">import</strong> java.beans.XMLDecoder;
<a class="jxr_linenumber" name="35" href="#35">35</a>  <strong class="jxr_keyword">import</strong> java.beans.XMLEncoder;
<a class="jxr_linenumber" name="36" href="#36">36</a>  <strong class="jxr_keyword">import</strong> java.beans.ExceptionListener;
<a class="jxr_linenumber" name="37" href="#37">37</a>  
<a class="jxr_linenumber" name="38" href="#38">38</a>  <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="39" href="#39">39</a>  <em class="jxr_javadoccomment"> * Base class for Event Data. Event Data contains data to be logged about an</em>
<a class="jxr_linenumber" name="40" href="#40">40</a>  <em class="jxr_javadoccomment"> * event. Users may extend this class for each EventType they want to log.</em>
<a class="jxr_linenumber" name="41" href="#41">41</a>  <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="42" href="#42">42</a>  <em class="jxr_javadoccomment"> * @author Ralph Goers</em>
<a class="jxr_linenumber" name="43" href="#43">43</a>  <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="44" href="#44">44</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../org/slf4j/ext/EventData.html">EventData</a> <strong class="jxr_keyword">implements</strong> Serializable {
<a class="jxr_linenumber" name="45" href="#45">45</a>    
<a class="jxr_linenumber" name="46" href="#46">46</a>    <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> serialVersionUID = 153270778642103985L;
<a class="jxr_linenumber" name="47" href="#47">47</a>    
<a class="jxr_linenumber" name="48" href="#48">48</a>    <strong class="jxr_keyword">private</strong> Map&lt;String, Object&gt; eventData = <strong class="jxr_keyword">new</strong> HashMap&lt;String, Object&gt;();
<a class="jxr_linenumber" name="49" href="#49">49</a>    <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String EVENT_MESSAGE = <span class="jxr_string">"EventMessage"</span>;
<a class="jxr_linenumber" name="50" href="#50">50</a>    <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String EVENT_TYPE = <span class="jxr_string">"EventType"</span>;
<a class="jxr_linenumber" name="51" href="#51">51</a>    <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String EVENT_DATETIME = <span class="jxr_string">"EventDateTime"</span>;
<a class="jxr_linenumber" name="52" href="#52">52</a>    <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String EVENT_ID = <span class="jxr_string">"EventId"</span>;
<a class="jxr_linenumber" name="53" href="#53">53</a>  
<a class="jxr_linenumber" name="54" href="#54">54</a>    <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="55" href="#55">55</a>  <em class="jxr_javadoccomment">   * Default Constructor</em>
<a class="jxr_linenumber" name="56" href="#56">56</a>  <em class="jxr_javadoccomment">   */</em>
<a class="jxr_linenumber" name="57" href="#57">57</a>    <strong class="jxr_keyword">public</strong> <a href="../../../org/slf4j/ext/EventData.html">EventData</a>() {
<a class="jxr_linenumber" name="58" href="#58">58</a>    }
<a class="jxr_linenumber" name="59" href="#59">59</a>  
<a class="jxr_linenumber" name="60" href="#60">60</a>    <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="61" href="#61">61</a>  <em class="jxr_javadoccomment">   * Constructor to create event data from a Map.</em>
<a class="jxr_linenumber" name="62" href="#62">62</a>  <em class="jxr_javadoccomment">   * </em>
<a class="jxr_linenumber" name="63" href="#63">63</a>  <em class="jxr_javadoccomment">   * @param map</em>
<a class="jxr_linenumber" name="64" href="#64">64</a>  <em class="jxr_javadoccomment">   *          The event data.</em>
<a class="jxr_linenumber" name="65" href="#65">65</a>  <em class="jxr_javadoccomment">   */</em>
<a class="jxr_linenumber" name="66" href="#66">66</a>    <strong class="jxr_keyword">public</strong> <a href="../../../org/slf4j/ext/EventData.html">EventData</a>(Map&lt;String, Object&gt; map) {
<a class="jxr_linenumber" name="67" href="#67">67</a>      eventData.putAll(map);
<a class="jxr_linenumber" name="68" href="#68">68</a>    }
<a class="jxr_linenumber" name="69" href="#69">69</a>  
<a class="jxr_linenumber" name="70" href="#70">70</a>    <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="71" href="#71">71</a>  <em class="jxr_javadoccomment">   * Construct from a serialized form of the Map containing the RequestInfo</em>
<a class="jxr_linenumber" name="72" href="#72">72</a>  <em class="jxr_javadoccomment">   * elements</em>
<a class="jxr_linenumber" name="73" href="#73">73</a>  <em class="jxr_javadoccomment">   * </em>
<a class="jxr_linenumber" name="74" href="#74">74</a>  <em class="jxr_javadoccomment">   * @param xml</em>
<a class="jxr_linenumber" name="75" href="#75">75</a>  <em class="jxr_javadoccomment">   *          The serialized form of the RequestInfo Map.</em>
<a class="jxr_linenumber" name="76" href="#76">76</a>  <em class="jxr_javadoccomment">   */</em>
<a class="jxr_linenumber" name="77" href="#77">77</a>    @SuppressWarnings(<span class="jxr_string">"unchecked"</span>)
<a class="jxr_linenumber" name="78" href="#78">78</a>    <strong class="jxr_keyword">public</strong> <a href="../../../org/slf4j/ext/EventData.html">EventData</a>(String xml) {
<a class="jxr_linenumber" name="79" href="#79">79</a>      ByteArrayInputStream bais = <strong class="jxr_keyword">new</strong> ByteArrayInputStream(xml.getBytes());
<a class="jxr_linenumber" name="80" href="#80">80</a>      <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="81" href="#81">81</a>        XMLDecoder decoder = <strong class="jxr_keyword">new</strong> XMLDecoder(bais);
<a class="jxr_linenumber" name="82" href="#82">82</a>        <strong class="jxr_keyword">this</strong>.eventData = (Map&lt;String, Object&gt;) decoder.readObject();
<a class="jxr_linenumber" name="83" href="#83">83</a>      } <strong class="jxr_keyword">catch</strong> (Exception e) {
<a class="jxr_linenumber" name="84" href="#84">84</a>        <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../org/slf4j/ext/EventException.html">EventException</a>(<span class="jxr_string">"Error decoding "</span> + xml, e);
<a class="jxr_linenumber" name="85" href="#85">85</a>      }
<a class="jxr_linenumber" name="86" href="#86">86</a>    }
<a class="jxr_linenumber" name="87" href="#87">87</a>  
<a class="jxr_linenumber" name="88" href="#88">88</a>    <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="89" href="#89">89</a>  <em class="jxr_javadoccomment">   * Serialize all the EventData items into an XML representation.</em>
<a class="jxr_linenumber" name="90" href="#90">90</a>  <em class="jxr_javadoccomment">   * </em>
<a class="jxr_linenumber" name="91" href="#91">91</a>  <em class="jxr_javadoccomment">   * @return an XML String containing all the EventDAta items.</em>
<a class="jxr_linenumber" name="92" href="#92">92</a>  <em class="jxr_javadoccomment">   */</em>
<a class="jxr_linenumber" name="93" href="#93">93</a>    <strong class="jxr_keyword">public</strong> String toXML() {
<a class="jxr_linenumber" name="94" href="#94">94</a>      <strong class="jxr_keyword">return</strong> toXML(eventData);
<a class="jxr_linenumber" name="95" href="#95">95</a>    }
<a class="jxr_linenumber" name="96" href="#96">96</a>  
<a class="jxr_linenumber" name="97" href="#97">97</a>    <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="98" href="#98">98</a>  <em class="jxr_javadoccomment">   * Serialize all the EventData items into an XML representation.</em>
<a class="jxr_linenumber" name="99" href="#99">99</a>  <em class="jxr_javadoccomment">   * </em>
<a class="jxr_linenumber" name="100" href="#100">100</a> <em class="jxr_javadoccomment">   * @param map the Map to transform</em>
<a class="jxr_linenumber" name="101" href="#101">101</a> <em class="jxr_javadoccomment">   * @return an XML String containing all the EventDAta items.</em>
<a class="jxr_linenumber" name="102" href="#102">102</a> <em class="jxr_javadoccomment">   */</em>
<a class="jxr_linenumber" name="103" href="#103">103</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String toXML(Map&lt;String, Object&gt; map) {
<a class="jxr_linenumber" name="104" href="#104">104</a>     ByteArrayOutputStream baos = <strong class="jxr_keyword">new</strong> ByteArrayOutputStream();
<a class="jxr_linenumber" name="105" href="#105">105</a>     <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="106" href="#106">106</a>       XMLEncoder encoder = <strong class="jxr_keyword">new</strong> XMLEncoder(baos);
<a class="jxr_linenumber" name="107" href="#107">107</a>       encoder.setExceptionListener(<strong class="jxr_keyword">new</strong> ExceptionListener() {
<a class="jxr_linenumber" name="108" href="#108">108</a>         <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> exceptionThrown(Exception exception) {
<a class="jxr_linenumber" name="109" href="#109">109</a>           exception.printStackTrace();
<a class="jxr_linenumber" name="110" href="#110">110</a>         }
<a class="jxr_linenumber" name="111" href="#111">111</a>       });
<a class="jxr_linenumber" name="112" href="#112">112</a>       encoder.writeObject(map);
<a class="jxr_linenumber" name="113" href="#113">113</a>       encoder.close();
<a class="jxr_linenumber" name="114" href="#114">114</a>       <strong class="jxr_keyword">return</strong> baos.toString();
<a class="jxr_linenumber" name="115" href="#115">115</a>     } <strong class="jxr_keyword">catch</strong> (Exception e) {
<a class="jxr_linenumber" name="116" href="#116">116</a>       e.printStackTrace();
<a class="jxr_linenumber" name="117" href="#117">117</a>       <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="118" href="#118">118</a>     }
<a class="jxr_linenumber" name="119" href="#119">119</a>   }
<a class="jxr_linenumber" name="120" href="#120">120</a> 
<a class="jxr_linenumber" name="121" href="#121">121</a>   <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="122" href="#122">122</a> <em class="jxr_javadoccomment">   * Retrieve the event identifier.</em>
<a class="jxr_linenumber" name="123" href="#123">123</a> <em class="jxr_javadoccomment">   * </em>
<a class="jxr_linenumber" name="124" href="#124">124</a> <em class="jxr_javadoccomment">   * @return The event identifier</em>
<a class="jxr_linenumber" name="125" href="#125">125</a> <em class="jxr_javadoccomment">   */</em>
<a class="jxr_linenumber" name="126" href="#126">126</a>   <strong class="jxr_keyword">public</strong> String getEventId() {
<a class="jxr_linenumber" name="127" href="#127">127</a>     <strong class="jxr_keyword">return</strong> (String) <strong class="jxr_keyword">this</strong>.eventData.get(EVENT_ID);
<a class="jxr_linenumber" name="128" href="#128">128</a>   }
<a class="jxr_linenumber" name="129" href="#129">129</a> 
<a class="jxr_linenumber" name="130" href="#130">130</a>   <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="131" href="#131">131</a> <em class="jxr_javadoccomment">   * Set the event identifier.</em>
<a class="jxr_linenumber" name="132" href="#132">132</a> <em class="jxr_javadoccomment">   * </em>
<a class="jxr_linenumber" name="133" href="#133">133</a> <em class="jxr_javadoccomment">   * @param eventId</em>
<a class="jxr_linenumber" name="134" href="#134">134</a> <em class="jxr_javadoccomment">   *          The event identifier.</em>
<a class="jxr_linenumber" name="135" href="#135">135</a> <em class="jxr_javadoccomment">   */</em>
<a class="jxr_linenumber" name="136" href="#136">136</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setEventId(String eventId) {
<a class="jxr_linenumber" name="137" href="#137">137</a>     <strong class="jxr_keyword">if</strong> (eventId == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="138" href="#138">138</a>       <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"eventId cannot be null"</span>);
<a class="jxr_linenumber" name="139" href="#139">139</a>     }
<a class="jxr_linenumber" name="140" href="#140">140</a>     <strong class="jxr_keyword">this</strong>.eventData.put(EVENT_ID, eventId);
<a class="jxr_linenumber" name="141" href="#141">141</a>   }
<a class="jxr_linenumber" name="142" href="#142">142</a> 
<a class="jxr_linenumber" name="143" href="#143">143</a>   <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="144" href="#144">144</a> <em class="jxr_javadoccomment">   * Retrieve the message text associated with this event, if any.</em>
<a class="jxr_linenumber" name="145" href="#145">145</a> <em class="jxr_javadoccomment">   * </em>
<a class="jxr_linenumber" name="146" href="#146">146</a> <em class="jxr_javadoccomment">   * @return The message text associated with this event or null if there is</em>
<a class="jxr_linenumber" name="147" href="#147">147</a> <em class="jxr_javadoccomment">   *         none.</em>
<a class="jxr_linenumber" name="148" href="#148">148</a> <em class="jxr_javadoccomment">   */</em>
<a class="jxr_linenumber" name="149" href="#149">149</a>   <strong class="jxr_keyword">public</strong> String getMessage() {
<a class="jxr_linenumber" name="150" href="#150">150</a>     <strong class="jxr_keyword">return</strong> (String) <strong class="jxr_keyword">this</strong>.eventData.get(EVENT_MESSAGE);
<a class="jxr_linenumber" name="151" href="#151">151</a>   }
<a class="jxr_linenumber" name="152" href="#152">152</a> 
<a class="jxr_linenumber" name="153" href="#153">153</a>   <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="154" href="#154">154</a> <em class="jxr_javadoccomment">   * Set the message text associated with this event.</em>
<a class="jxr_linenumber" name="155" href="#155">155</a> <em class="jxr_javadoccomment">   * </em>
<a class="jxr_linenumber" name="156" href="#156">156</a> <em class="jxr_javadoccomment">   * @param message</em>
<a class="jxr_linenumber" name="157" href="#157">157</a> <em class="jxr_javadoccomment">   *          The message text.</em>
<a class="jxr_linenumber" name="158" href="#158">158</a> <em class="jxr_javadoccomment">   */</em>
<a class="jxr_linenumber" name="159" href="#159">159</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setMessage(String message) {
<a class="jxr_linenumber" name="160" href="#160">160</a>     <strong class="jxr_keyword">this</strong>.eventData.put(EVENT_MESSAGE, message);
<a class="jxr_linenumber" name="161" href="#161">161</a>   }
<a class="jxr_linenumber" name="162" href="#162">162</a> 
<a class="jxr_linenumber" name="163" href="#163">163</a>   <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="164" href="#164">164</a> <em class="jxr_javadoccomment">   * Retrieve the date and time the event occurred.</em>
<a class="jxr_linenumber" name="165" href="#165">165</a> <em class="jxr_javadoccomment">   * </em>
<a class="jxr_linenumber" name="166" href="#166">166</a> <em class="jxr_javadoccomment">   * @return The Date associated with the event.</em>
<a class="jxr_linenumber" name="167" href="#167">167</a> <em class="jxr_javadoccomment">   */</em>
<a class="jxr_linenumber" name="168" href="#168">168</a>   <strong class="jxr_keyword">public</strong> Date getEventDateTime() {
<a class="jxr_linenumber" name="169" href="#169">169</a>     <strong class="jxr_keyword">return</strong> (Date) <strong class="jxr_keyword">this</strong>.eventData.get(EVENT_DATETIME);
<a class="jxr_linenumber" name="170" href="#170">170</a>   }
<a class="jxr_linenumber" name="171" href="#171">171</a> 
<a class="jxr_linenumber" name="172" href="#172">172</a>   <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="173" href="#173">173</a> <em class="jxr_javadoccomment">   * Set the date and time the event occurred in case it is not the same as when</em>
<a class="jxr_linenumber" name="174" href="#174">174</a> <em class="jxr_javadoccomment">   * the event was logged.</em>
<a class="jxr_linenumber" name="175" href="#175">175</a> <em class="jxr_javadoccomment">   * </em>
<a class="jxr_linenumber" name="176" href="#176">176</a> <em class="jxr_javadoccomment">   * @param eventDateTime</em>
<a class="jxr_linenumber" name="177" href="#177">177</a> <em class="jxr_javadoccomment">   *          The event Date.</em>
<a class="jxr_linenumber" name="178" href="#178">178</a> <em class="jxr_javadoccomment">   */</em>
<a class="jxr_linenumber" name="179" href="#179">179</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setEventDateTime(Date eventDateTime) {
<a class="jxr_linenumber" name="180" href="#180">180</a>     <strong class="jxr_keyword">this</strong>.eventData.put(EVENT_DATETIME, eventDateTime);
<a class="jxr_linenumber" name="181" href="#181">181</a>   }
<a class="jxr_linenumber" name="182" href="#182">182</a> 
<a class="jxr_linenumber" name="183" href="#183">183</a>   <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="184" href="#184">184</a> <em class="jxr_javadoccomment">   * Set the type of event that occurred.</em>
<a class="jxr_linenumber" name="185" href="#185">185</a> <em class="jxr_javadoccomment">   * </em>
<a class="jxr_linenumber" name="186" href="#186">186</a> <em class="jxr_javadoccomment">   * @param eventType</em>
<a class="jxr_linenumber" name="187" href="#187">187</a> <em class="jxr_javadoccomment">   *          The type of the event.</em>
<a class="jxr_linenumber" name="188" href="#188">188</a> <em class="jxr_javadoccomment">   */</em>
<a class="jxr_linenumber" name="189" href="#189">189</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setEventType(String eventType) {
<a class="jxr_linenumber" name="190" href="#190">190</a>     <strong class="jxr_keyword">this</strong>.eventData.put(EVENT_TYPE, eventType);
<a class="jxr_linenumber" name="191" href="#191">191</a>   }
<a class="jxr_linenumber" name="192" href="#192">192</a> 
<a class="jxr_linenumber" name="193" href="#193">193</a>   <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="194" href="#194">194</a> <em class="jxr_javadoccomment">   * Retrieve the type of the event.</em>
<a class="jxr_linenumber" name="195" href="#195">195</a> <em class="jxr_javadoccomment">   * </em>
<a class="jxr_linenumber" name="196" href="#196">196</a> <em class="jxr_javadoccomment">   * @return The event type.</em>
<a class="jxr_linenumber" name="197" href="#197">197</a> <em class="jxr_javadoccomment">   */</em>
<a class="jxr_linenumber" name="198" href="#198">198</a>   <strong class="jxr_keyword">public</strong> String getEventType() {
<a class="jxr_linenumber" name="199" href="#199">199</a>     <strong class="jxr_keyword">return</strong> (String) <strong class="jxr_keyword">this</strong>.eventData.get(EVENT_TYPE);
<a class="jxr_linenumber" name="200" href="#200">200</a>   }
<a class="jxr_linenumber" name="201" href="#201">201</a> 
<a class="jxr_linenumber" name="202" href="#202">202</a>   <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="203" href="#203">203</a> <em class="jxr_javadoccomment">   * Add arbitrary attributes about the event.</em>
<a class="jxr_linenumber" name="204" href="#204">204</a> <em class="jxr_javadoccomment">   * </em>
<a class="jxr_linenumber" name="205" href="#205">205</a> <em class="jxr_javadoccomment">   * @param name</em>
<a class="jxr_linenumber" name="206" href="#206">206</a> <em class="jxr_javadoccomment">   *          The attribute's key.</em>
<a class="jxr_linenumber" name="207" href="#207">207</a> <em class="jxr_javadoccomment">   * @param obj</em>
<a class="jxr_linenumber" name="208" href="#208">208</a> <em class="jxr_javadoccomment">   *          The data associated with the key.</em>
<a class="jxr_linenumber" name="209" href="#209">209</a> <em class="jxr_javadoccomment">   */</em>
<a class="jxr_linenumber" name="210" href="#210">210</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> put(String name, Serializable obj) {
<a class="jxr_linenumber" name="211" href="#211">211</a>     <strong class="jxr_keyword">this</strong>.eventData.put(name, obj);
<a class="jxr_linenumber" name="212" href="#212">212</a>   }
<a class="jxr_linenumber" name="213" href="#213">213</a> 
<a class="jxr_linenumber" name="214" href="#214">214</a>   <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="215" href="#215">215</a> <em class="jxr_javadoccomment">   * Retrieve an event attribute.</em>
<a class="jxr_linenumber" name="216" href="#216">216</a> <em class="jxr_javadoccomment">   * </em>
<a class="jxr_linenumber" name="217" href="#217">217</a> <em class="jxr_javadoccomment">   * @param name</em>
<a class="jxr_linenumber" name="218" href="#218">218</a> <em class="jxr_javadoccomment">   *          The attribute's key.</em>
<a class="jxr_linenumber" name="219" href="#219">219</a> <em class="jxr_javadoccomment">   * @return The value associated with the key or null if the key is not</em>
<a class="jxr_linenumber" name="220" href="#220">220</a> <em class="jxr_javadoccomment">   *         present.</em>
<a class="jxr_linenumber" name="221" href="#221">221</a> <em class="jxr_javadoccomment">   */</em>
<a class="jxr_linenumber" name="222" href="#222">222</a>   <strong class="jxr_keyword">public</strong> Serializable get(String name) {
<a class="jxr_linenumber" name="223" href="#223">223</a>     <strong class="jxr_keyword">return</strong> (Serializable) <strong class="jxr_keyword">this</strong>.eventData.get(name);
<a class="jxr_linenumber" name="224" href="#224">224</a>   }
<a class="jxr_linenumber" name="225" href="#225">225</a> 
<a class="jxr_linenumber" name="226" href="#226">226</a>   <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="227" href="#227">227</a> <em class="jxr_javadoccomment">   * Populate the event data from a Map.</em>
<a class="jxr_linenumber" name="228" href="#228">228</a> <em class="jxr_javadoccomment">   * </em>
<a class="jxr_linenumber" name="229" href="#229">229</a> <em class="jxr_javadoccomment">   * @param data</em>
<a class="jxr_linenumber" name="230" href="#230">230</a> <em class="jxr_javadoccomment">   *          The Map to copy.</em>
<a class="jxr_linenumber" name="231" href="#231">231</a> <em class="jxr_javadoccomment">   */</em>
<a class="jxr_linenumber" name="232" href="#232">232</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> putAll(Map&lt;String, Object&gt; data) {
<a class="jxr_linenumber" name="233" href="#233">233</a>     <strong class="jxr_keyword">this</strong>.eventData.putAll(data);
<a class="jxr_linenumber" name="234" href="#234">234</a>   }
<a class="jxr_linenumber" name="235" href="#235">235</a> 
<a class="jxr_linenumber" name="236" href="#236">236</a>   <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="237" href="#237">237</a> <em class="jxr_javadoccomment">   * Returns the number of attributes in the EventData.</em>
<a class="jxr_linenumber" name="238" href="#238">238</a> <em class="jxr_javadoccomment">   * </em>
<a class="jxr_linenumber" name="239" href="#239">239</a> <em class="jxr_javadoccomment">   * @return the number of attributes in the EventData.</em>
<a class="jxr_linenumber" name="240" href="#240">240</a> <em class="jxr_javadoccomment">   */</em>
<a class="jxr_linenumber" name="241" href="#241">241</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getSize() {
<a class="jxr_linenumber" name="242" href="#242">242</a>     <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.eventData.size();
<a class="jxr_linenumber" name="243" href="#243">243</a>   }
<a class="jxr_linenumber" name="244" href="#244">244</a> 
<a class="jxr_linenumber" name="245" href="#245">245</a>   <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="246" href="#246">246</a> <em class="jxr_javadoccomment">   * Returns an Iterator over all the entries in the EventDAta.</em>
<a class="jxr_linenumber" name="247" href="#247">247</a> <em class="jxr_javadoccomment">   * </em>
<a class="jxr_linenumber" name="248" href="#248">248</a> <em class="jxr_javadoccomment">   * @return an Iterator that can be used to access all the event attributes.</em>
<a class="jxr_linenumber" name="249" href="#249">249</a> <em class="jxr_javadoccomment">   */</em>
<a class="jxr_linenumber" name="250" href="#250">250</a>   <strong class="jxr_keyword">public</strong> Iterator&lt;Map.Entry&lt;String, Object&gt;&gt; getEntrySetIterator() {
<a class="jxr_linenumber" name="251" href="#251">251</a>     <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.eventData.entrySet().iterator();
<a class="jxr_linenumber" name="252" href="#252">252</a>   }
<a class="jxr_linenumber" name="253" href="#253">253</a> 
<a class="jxr_linenumber" name="254" href="#254">254</a>   <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="255" href="#255">255</a> <em class="jxr_javadoccomment">   * Retrieve all the attributes in the EventData as a Map. Changes to this map</em>
<a class="jxr_linenumber" name="256" href="#256">256</a> <em class="jxr_javadoccomment">   * will be reflected in the EventData.</em>
<a class="jxr_linenumber" name="257" href="#257">257</a> <em class="jxr_javadoccomment">   * </em>
<a class="jxr_linenumber" name="258" href="#258">258</a> <em class="jxr_javadoccomment">   * @return The Map of attributes in this EventData instance.</em>
<a class="jxr_linenumber" name="259" href="#259">259</a> <em class="jxr_javadoccomment">   */</em>
<a class="jxr_linenumber" name="260" href="#260">260</a>   <strong class="jxr_keyword">public</strong> Map&lt;String, Object&gt; getEventMap() {
<a class="jxr_linenumber" name="261" href="#261">261</a>     <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.eventData;
<a class="jxr_linenumber" name="262" href="#262">262</a>   }
<a class="jxr_linenumber" name="263" href="#263">263</a> 
<a class="jxr_linenumber" name="264" href="#264">264</a>   <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="265" href="#265">265</a> <em class="jxr_javadoccomment">   * Convert the EventData to a String.</em>
<a class="jxr_linenumber" name="266" href="#266">266</a> <em class="jxr_javadoccomment">   * </em>
<a class="jxr_linenumber" name="267" href="#267">267</a> <em class="jxr_javadoccomment">   * @return The EventData as a String.</em>
<a class="jxr_linenumber" name="268" href="#268">268</a> <em class="jxr_javadoccomment">   */</em>
<a class="jxr_linenumber" name="269" href="#269">269</a>   @Override
<a class="jxr_linenumber" name="270" href="#270">270</a>   <strong class="jxr_keyword">public</strong> String toString() {
<a class="jxr_linenumber" name="271" href="#271">271</a>     <strong class="jxr_keyword">return</strong> toXML();
<a class="jxr_linenumber" name="272" href="#272">272</a>   }
<a class="jxr_linenumber" name="273" href="#273">273</a> 
<a class="jxr_linenumber" name="274" href="#274">274</a>   <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="275" href="#275">275</a> <em class="jxr_javadoccomment">   * Compare two EventData objects for equality.</em>
<a class="jxr_linenumber" name="276" href="#276">276</a> <em class="jxr_javadoccomment">   * </em>
<a class="jxr_linenumber" name="277" href="#277">277</a> <em class="jxr_javadoccomment">   * @param o</em>
<a class="jxr_linenumber" name="278" href="#278">278</a> <em class="jxr_javadoccomment">   *          The Object to compare.</em>
<a class="jxr_linenumber" name="279" href="#279">279</a> <em class="jxr_javadoccomment">   * @return true if the objects are the same instance or contain all the same</em>
<a class="jxr_linenumber" name="280" href="#280">280</a> <em class="jxr_javadoccomment">   *         keys and their values.</em>
<a class="jxr_linenumber" name="281" href="#281">281</a> <em class="jxr_javadoccomment">   */</em>
<a class="jxr_linenumber" name="282" href="#282">282</a>   @SuppressWarnings(<span class="jxr_string">"unchecked"</span>)
<a class="jxr_linenumber" name="283" href="#283">283</a>   @Override
<a class="jxr_linenumber" name="284" href="#284">284</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> equals(Object o) {
<a class="jxr_linenumber" name="285" href="#285">285</a>     <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong> == o) {
<a class="jxr_linenumber" name="286" href="#286">286</a>       <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="287" href="#287">287</a>     }
<a class="jxr_linenumber" name="288" href="#288">288</a>     <strong class="jxr_keyword">if</strong> (!(o instanceof EventData || o instanceof Map)) {
<a class="jxr_linenumber" name="289" href="#289">289</a>       <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="290" href="#290">290</a>     }
<a class="jxr_linenumber" name="291" href="#291">291</a>     Map&lt;String, Object&gt; map = (o instanceof EventData) ? ((EventData) o)
<a class="jxr_linenumber" name="292" href="#292">292</a>         .getEventMap() : (Map&lt;String, Object&gt;) o;
<a class="jxr_linenumber" name="293" href="#293">293</a> 
<a class="jxr_linenumber" name="294" href="#294">294</a>     <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.eventData.equals(map);
<a class="jxr_linenumber" name="295" href="#295">295</a>   }
<a class="jxr_linenumber" name="296" href="#296">296</a> 
<a class="jxr_linenumber" name="297" href="#297">297</a>   <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="298" href="#298">298</a> <em class="jxr_javadoccomment">   * Compute the hashCode for this EventData instance.</em>
<a class="jxr_linenumber" name="299" href="#299">299</a> <em class="jxr_javadoccomment">   * </em>
<a class="jxr_linenumber" name="300" href="#300">300</a> <em class="jxr_javadoccomment">   * @return The hashcode for this EventData instance.</em>
<a class="jxr_linenumber" name="301" href="#301">301</a> <em class="jxr_javadoccomment">   */</em>
<a class="jxr_linenumber" name="302" href="#302">302</a>   @Override
<a class="jxr_linenumber" name="303" href="#303">303</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> hashCode() {
<a class="jxr_linenumber" name="304" href="#304">304</a>     <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.eventData.hashCode();
<a class="jxr_linenumber" name="305" href="#305">305</a>   }
<a class="jxr_linenumber" name="306" href="#306">306</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

